<?php
/**
 * Ruth Library
 * $Id: ReflectionMethod.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Annotation
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Annotation_Parser
 */
require_once 'Ruth/Annotation/Parser.php';

/**
 * An extension of ReflectionMethod that adds a few methods to aid in the
 * extraction of annotations from docblock comments.
 *
 * @category   Ruth
 * @package    Ruth_Annotation
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */
class Ruth_Annotation_ReflectionMethod extends ReflectionMethod
{
    /**
     * The annotations associated with the method, or null if the doc block
     * comment has not been parsed yet; the doc block comment is parsed on
     * demand.
     *
     * @var array|null
     */
    protected $_annotations = null;

    /**
     * Returns true if the annotation $name is set, false otherwise.
     *
     * @param string $name
     * @return boolean
     * @throws Ruth_Annotation_Exception
     */
    public function hasAnnotation($name)
    {
        if ($this->_annotations === null) {
            $this->_parseAnnotations();
        }

        return isset($this->_annotations[$name]);
    }

    /**
     * Returns the annotation value corresponding to $name, or null if the
     * annotation does not exist.
     *
     * @param string $name
     * @return string|null
     * @throws Ruth_Annotation_Exception
     */
    public function getAnnotation($name)
    {
        if ($this->_annotations === null) {
            $this->_parseAnnotations();
        }

        if (isset($this->_annotations[$name])) {
            return $this->_annotations[$name]->value;
        } else {
            return null;
        }
    }

    /**
     * Extracts the annotations from the method's docblock comment and
     * assigns them to the _annotations member.
     *
     * @throws Ruth_Annotation_Exception
     */
    protected function _parseAnnotations()
    {
        $docComment = $this->getDocComment();

        if ($docComment === false) {
            $this->_annotations = array();
            return;
        }

        $this->_annotations = Ruth_Annotation_Parser::parse($docComment);
    }
}
 
// vim: sw=4:ts=4:sts=4:et
